APIs are mechanisms that enable two software components to communicate with each other using a set of definitions and protocols.  We offer two APIs:

1. Webhook APIs provide efficient real-time updates
2. Traditional REST API for more common queries and programming activities

An API token (more commonly called a bearer token) is a security token used to authenticate and authorize requests and access to protected resources in web applications and APIs.

The name "bearer authentication" means “give access to the bearer of this token.”  We use it with our API to identify and authorize your access.

NOTE: Document every API token you create so you can quickly delete it should it become compromised.

To delete your API token, select the trash bin icon to the right of the token. This is the button to select should your token become compromised.

API tokens are free! Generate as many tokens as you have partners to minimize your risk if one is leaked.

Follow these steps to find your API token:

1. From your portal, select ‘Setup’ from the top toolbar.
2. Select ‘API/Developers’ from the left menu.
3. Select ‘+ Create New Token.’

Follow these steps to find your host link:

1. From the API/Developers page, select the ‘API documentation page’ link.
2. Locate your API host link in the middle of the page.

NOTE: The API token and host link are specific to each account.

NOTE: API V3 is currently in beta. To enable API V3, please contact Support at 877-732-4980.

Standardized objects + field names

• Wherever possible, we reused common objects, so that most messages will only have a handful of unique fields that are tied to their actual purpose. Field names should now also be consistent between different messages.

Retry failed delivery

• If a message fails on its first delivery attempt due to something that could be a temporary network issue, we will reattempt delivery up to three times, with a rolling backoff.

Saving of undeliverable messages

• Messages that can't be delivered for whatever reason are saved locally for several days, and can be resent if needed after the outage has passed. We will hopefully have a formal process for this eventually, but for now, if your system experiences an outage and you would like to have the affected messages resent, please contact the email addresses above.

Increased reliability

• The new system has separated larger clients into their own instances, and rate-limits endpoints that exceed a 50% failure rate until they recover. For most integrations, this should mean a far lower rate of delayed or dropped messages from our side.

Custom data (pending)

• We have the ability to include any custom data that you provide in the messages for most objects - for example, if you would like to add some identifying information for all of your employees in our system, we will include that when those employees appear in messages. The ability to add and maintain this information will be part of our new external API, which is still under development.

NOTE: API V3 is currently in beta. To enable API V3, please contact Support at 877-732-4980.

Yes, you will need to generate a new API token for V3.

To generate a new API key:

1. On the portal, select ‘Setup’ from the top toolbar.
2. Select ‘API/Developers’ from the left menu.
3. Select ‘Experimental’ API Version from the top right corner.
4. Select the orange ‘Create New API Key’ button.

NOTE: API V3 is currently in beta. To enable API V3, please contact Support at 877-732-4980.

To authenticate your V3 API Key:

1. On the portal, select ‘Setup’ from the top toolbar.
2. Select ‘API/Developers’ from the left menu.
3. Copy your API key.
4. Select the ‘document’ link.
   • https://api.linxup.com/pullapi/swagger-ui/index.html
5. Generate a JWT token by selecting the green ‘jwts’ dropdown menu and selecting the ‘Try it out’ button.
   • Paste your API key.
   • Select the ‘Execute’ button.
   • Copy the response body. This is the token you will use to authenticate.
6. Select the green ‘Authorize’ button.
7. Paste the token and select ‘Authorize.’
   • You can now test calls by choosing the call, selecting ‘Try it out’ and ‘Execute.’